docs: document image/figure float and alignment#1
Closed
Conversation
…-Documentation#503) * Document image zoom and lightbox features Add comprehensive documentation for the new image zoom/lightbox feature available in the TYPO3 documentation theme. Extension authors can now use CSS classes to enable different zoom modes on figures and images. Coverage includes: - Five zoom modes: lightbox, gallery, inline, lens, and css-only - Practical RST examples for each mode - Accessibility features (keyboard navigation, ARIA, screen readers) - Best practices and use case guidance - JavaScript-free fallback option This enables extension authors to enhance image viewing in their documentation without requiring custom JavaScript or external plugins. * Fix keyboard navigation docs for Inline and Lens modes - Inline zoom has full keyboard support: Tab, +/-, arrows, ESC/0 - Lens mode has keyboard activation: Tab, Enter/Space, arrows, ESC * docs: update zoom syntax to use :zoom: option instead of class * docs: add zoom-factor option and version note - Document :zoom-factor: option for lens mode magnification - Add versionadded directive noting feature requires v0.2.0+ * fix: correct render-guides version to 0.36.0 * docs: add :zoom: lightbox to standard image examples Per review feedback, add :zoom: lightbox to the basic examples so users copying them will use zoom by default for screenshots.
…cumentation#506) - Example 1: Remove :zoom: lightbox (demonstrates :target: for external links) - Example 2: Remove :target: (demonstrates :zoom: lightbox for zoom functionality) The :target: and :zoom: options conflict with each other. This change provides clear examples of both features without conflict.
Add documentation for the float and alignment feature introduced in render-guides 0.37.0 (PR #1174). Covers CSS class approach (:class: float-left/float-right), the :align: option on figures, clearing floats with rst-class:: clear-both, and responsive behavior. Includes three live examples (Examples 8-10) and best practices.
Owner
Author
|
Moved to netresearch#1 for Copilot review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
:class:and:align:to the optional parameters list with cross-referencesfloat-left/float-right),:align:option, clearing floats (rst-class:: clear-both), and responsive behaviorContext
The render-guides 0.37.0 release will add CSS float/alignment support for images and figures. This PR adds the corresponding user documentation.
Test plan
:ref:image-float-alignment) resolve from the parameters list